﻿#region MIT Licence
/*
 * Copyright (C) 2014 PdfCreative
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
 * and associated documentation files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, publish, distribute, 
 * sublicense, and/or sell copies of the Software, and to permit persons to whom 
 * the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included 
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE 
 * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#endregion

using System;
using System.Collections.Generic;
using System.Text;

namespace PdfCreative.Pdf.Writer.Embedding.Predictors
{
    /// <summary>
    /// The PredictorAttribute attribute is used to decorate predictor classes and assign them a
    /// predictor code. Given a code, the Predictor base class can retrieve and return appropriate
    /// predictor subclasses.
    /// </summary>
    [AttributeUsage(AttributeTargets.Class)]
    internal class PredictorAttribute : Attribute
    {
		// Private fields
		// ==============
		#region Private fields
        private PredictorCode _predictorCode;
		#endregion



		// Public properties
		// =================
		#region Public properties
		/// <summary>
		/// Sets or retrieves the predictor code.
		/// </summary>
        public PredictorCode PredictorCode
		{
            get { return _predictorCode; }
            set { _predictorCode = value; }
		}
		#endregion



		// Public constructor
		// ==================
		#region public constructor
		/// <summary>
		/// Constructs a new instance using the specified predictor code.
		/// </summary>
        public PredictorAttribute(PredictorCode predictorCode)
		{
			_predictorCode = predictorCode;
		}
		#endregion      
    }
}
